-- Network Working Group K. White
-- Request for Comments: 2925 IBM Corp.
-- Category: Standards Track September 2000-- Definitions of Managed Objects for Remote Ping, Traceroute, and
-- Lookup OperationsDISMAN-PING-MIB DEFINITIONS::=BEGINIMPORTSMODULE-IDENTITY,OBJECT-TYPE,Integer32,
Unsigned32, mib-2,NOTIFICATION-TYPE,OBJECT-IDENTITYFROM SNMPv2-SMI -- RFC2578TEXTUAL-CONVENTION,RowStatus,StorageType,DateAndTime,TruthValueFROM SNMPv2-TC -- RFC2579MODULE-COMPLIANCE,OBJECT-GROUP,NOTIFICATION-GROUPFROM SNMPv2-CONF -- RFC2580InterfaceIndexOrZero-- RFC2863FROM IF-MIB
SnmpAdminStringFROM SNMP-FRAMEWORK-MIB -- RFC2571InetAddressType,InetAddressFROM INET-ADDRESS-MIB;-- RFC2851pingMIB MODULE-IDENTITYLAST-UPDATED"200009210000Z"-- 21 September 2000ORGANIZATION"IETF Distributed Management Working Group"CONTACT-INFO"Kenneth White
International Business Machines Corporation
Network Computing Software Division
Research Triangle Park, NC, USA
E-mail: wkenneth@us.ibm.com"DESCRIPTION"The Ping MIB (DISMAN-PING-MIB) provides the capability of
controlling the use of the ping function at a remote
host."-- Revision historyREVISION"200009210000Z"-- 21 September 2000
DESCRIPTION"Initial version, published as RFC 2925."::={ mib-2 80}-- Textual ConventionsOperationResponseStatus::=TEXTUAL-CONVENTIONSTATUScurrentDESCRIPTION"Used to report the result of an operation:
responseReceived(1) - Operation completes successfully.
unknown(2) - Operation failed due to unknown error.
internalError(3) - An implementation detected an error
in its own processing that caused an operation
to fail.
requestTimedOut(4) - Operation failed to receive a
valid reply within the time limit imposed on it.
unknownDestinationAddress(5) - Invalid destination
address.
noRouteToTarget(6) - Could not find a route to target.
interfaceInactiveToTarget(7) - The interface to be
used in sending a probe is inactive without an
alternate route existing.
arpFailure(8) - Unable to resolve a target address to a
media specific address.
maxConcurrentLimitReached(9) - The maximum number of
concurrent active operations would have been exceeded
if the corresponding operation was allowed.
unableToResolveDnsName(10) - The DNS name specified was
unable to be mapped to an IP address.
invalidHostAddress(11) - The IP address for a host
has been determined to be invalid. Examples of this
are broadcast or multicast addresses."SYNTAXINTEGER{responseReceived(1),unknown(2),internalError(3),requestTimedOut(4),
unknownDestinationAddress(5),noRouteToTarget(6),interfaceInactiveToTarget(7),arpFailure(8),maxConcurrentLimitReached(9),unableToResolveDnsName(10),invalidHostAddress(11)}-- Top level structure of the MIBpingNotifications OBJECTIDENTIFIER::={ pingMIB 0}pingObjects OBJECTIDENTIFIER::={ pingMIB 1}pingConformance OBJECTIDENTIFIER::={ pingMIB 2}-- The registration node (point) for ping implementation typespingImplementationTypeDomains OBJECTIDENTIFIER::={ pingMIB 3}pingIcmpEcho OBJECT-IDENTITYSTATUScurrentDESCRIPTION"Indicates that an implementation is using the Internet
Control Message Protocol (ICMP) 'ECHO' facility."::={ pingImplementationTypeDomains 1}pingUdpEcho OBJECT-IDENTITY
STATUScurrentDESCRIPTION"Indicates that an implementation is using the UDP echo
port (7)."REFERENCE"RFC 862, 'Echo Protocol'."::={ pingImplementationTypeDomains 2}pingSnmpQuery OBJECT-IDENTITYSTATUScurrentDESCRIPTION"Indicates that an implementation is an SNMP query to
calculate a round trip time."::={ pingImplementationTypeDomains 3}pingTcpConnectionAttempt OBJECT-IDENTITYSTATUScurrentDESCRIPTION"Indicates that an implementation is attempting to
connect to a TCP port in order to calculate a round
trip time."::={ pingImplementationTypeDomains 4}-- Simple Object DefinitionspingMaxConcurrentRequests OBJECT-TYPESYNTAXUnsigned32UNITS"requests"MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The maximum number of concurrent active ping requests
that are allowed within an agent implementation. A value
of 0 for this object implies that there is no limit for
the number of concurrent active requests in effect."DEFVAL{10}::={ pingObjects 1}-- Ping Control TablepingCtlTable OBJECT-TYPESYNTAXSEQUENCEOF PingCtlEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the ping Control Table for providing, via SNMP,
the capability of performing ping operations at
a remote host. The results of these operations are
stored in the pingResultsTable and the
pingProbeHistoryTable."::={ pingObjects 2}pingCtlEntry OBJECT-TYPESYNTAX PingCtlEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the pingCtlTable. The first index
element, pingCtlOwnerIndex, is of type SnmpAdminString,
a textual convention that allows for use of the SNMPv3
View-Based Access Control Model (RFC 2575 [11], VACM)
and allows an management application to identify its
entries. The second index, pingCtlTestName (also an
SnmpAdminString), enables the same management
application to have multiple outstanding requests."INDEX{
pingCtlOwnerIndex,
pingCtlTestName
}::={ pingCtlTable 1}
PingCtlEntry ::=SEQUENCE{
pingCtlOwnerIndex SnmpAdminString,
pingCtlTestName SnmpAdminString,
pingCtlTargetAddressType InetAddressType,
pingCtlTargetAddress InetAddress,
pingCtlDataSize Unsigned32,
pingCtlTimeOut Unsigned32,
pingCtlProbeCount Unsigned32,
pingCtlAdminStatus INTEGER,
pingCtlDataFill OCTETSTRING,
pingCtlFrequency Unsigned32,
pingCtlMaxRows Unsigned32,
pingCtlStorageType StorageType,
pingCtlTrapGeneration BITS,
pingCtlTrapProbeFailureFilter Unsigned32,
pingCtlTrapTestFailureFilter Unsigned32,
pingCtlType OBJECTIDENTIFIER,
pingCtlDescr SnmpAdminString,
pingCtlSourceAddressType InetAddressType,
pingCtlSourceAddress InetAddress,
pingCtlIfIndex InterfaceIndexOrZero,
pingCtlByPassRouteTable TruthValue,
pingCtlDSField Unsigned32,
pingCtlRowStatus RowStatus}pingCtlOwnerIndex OBJECT-TYPESYNTAXSnmpAdminString(SIZE(0..32))MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"To facilitate the provisioning of access control by a
security administrator using the View-Based Access
Control Model (RFC 2575, VACM) for tables in which
multiple users may need to independently create or
modify entries, the initial index is used as an 'owner
index'. Such an initial index has a syntax of
SnmpAdminString, and can thus be trivially mapped to a
securityName or groupName as defined in VACM, in
accordance with a security policy.
When used in conjunction with such a security policy all
entries in the table belonging to a particular user (or
group) will have the same value for this initial index.
For a given user's entries in a particular table, the
object identifiers for the information in these entries
will have the same subidentifiers (except for the 'column'
subidentifier) up to the end of the encoded owner index.
To configure VACM to permit access to this portion of the
table, one would create vacmViewTreeFamilyTable entries
with the value of vacmViewTreeFamilySubtree including
the owner index portion, and vacmViewTreeFamilyMask
'wildcarding' the column subidentifier. More elaborate
configurations are possible."::={ pingCtlEntry 1}pingCtlTestName OBJECT-TYPESYNTAXSnmpAdminString(SIZE(0..32))MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"The name of the ping test. This is locally unique, within
the scope of an pingCtlOwnerIndex."::={ pingCtlEntry 2}pingCtlTargetAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the type of host address to be used at a remote
host for performing a ping operation."DEFVAL{ unknown }::={ pingCtlEntry 3}
pingCtlTargetAddress OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the host address to be used at a remote host for
performing a ping operation. The host address type is
determined by the object value of corresponding
pingCtlTargetAddressType.
A value for this object MUST be set prior to transitioning
its corresponding pingCtlEntry to active(1) via
pingCtlRowStatus."DEFVAL{ ''H }::={ pingCtlEntry 4}pingCtlDataSize OBJECT-TYPESYNTAXUnsigned32(0..65507)UNITS"octets"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the size of the data portion to be
transmitted in a ping operation in octets. A ping
request is usually an ICMP message encoded
into an IP packet. An IP packet has a maximum size
of 65535 octets. Subtracting the size of the ICMP
or UDP header (both 8 octets) and the size of the IP
header (20 octets) yields a maximum size of 65507
octets."DEFVAL{0}::={ pingCtlEntry 5}pingCtlTimeOut OBJECT-TYPESYNTAXUnsigned32(1..60)UNITS"seconds"
MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the time-out value, in seconds, for a
remote ping operation."DEFVAL{3}::={ pingCtlEntry 6}pingCtlProbeCount OBJECT-TYPESYNTAXUnsigned32(1..15)UNITS"probes"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the number of times to perform a ping
operation at a remote host."DEFVAL{1}::={ pingCtlEntry 7}pingCtlAdminStatus OBJECT-TYPESYNTAXINTEGER{enabled(1),-- test should be starteddisabled(2)-- test should be stopped}MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Reflects the desired state that a pingCtlEntry should be
in:
enabled(1) - Attempt to activate the test as defined by
this pingCtlEntry.
disabled(2) - Deactivate the test as defined by this
pingCtlEntry.
Refer to the corresponding pingResultsOperStatus to
determine the operational state of the test defined by
this entry."DEFVAL{ disabled }::={ pingCtlEntry 8}pingCtlDataFill OBJECT-TYPESYNTAXOCTETSTRING(SIZE(0..1024))MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The content of this object is used together with the
corresponding pingCtlDataSize value to determine how to
fill the data portion of a probe packet. The option of
selecting a data fill pattern can be useful when links
are compressed or have data pattern sensitivities. The
contents of pingCtlDataFill should be repeated in a ping
packet when the size of the data portion of the ping
packet is greater than the size of pingCtlDataFill."DEFVAL{ '00'H }::={ pingCtlEntry 9}pingCtlFrequency OBJECT-TYPESYNTAXUnsigned32UNITS"seconds"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The number of seconds to wait before repeating a ping test
as defined by the value of the various objects in the
corresponding row.
A single ping test consists of a series of ping probes.
The number of probes is determined by the value of the
corresponding pingCtlProbeCount object. After a single
test completes the number of seconds as defined by the
value of pingCtlFrequency MUST elapse before the
next ping test is started.
A value of 0 for this object implies that the test
as defined by the corresponding entry will not be
repeated."DEFVAL{0}::={ pingCtlEntry 10}pingCtlMaxRows OBJECT-TYPESYNTAXUnsigned32UNITS"rows"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The maximum number of entries allowed in the
pingProbeHistoryTable. An implementation of this
MIB will remove the oldest entry in the
pingProbeHistoryTable to allow the addition of an
new entry once the number of rows in the
pingProbeHistoryTable reaches this value.
Old entries are not removed when a new test is
started. Entries are added to the pingProbeHistoryTable
until pingCtlMaxRows is reached before entries begin to
be removed.
A value of 0 for this object disables creation of
pingProbeHistoryTable entries."DEFVAL{50}::={ pingCtlEntry 11}pingCtlStorageType OBJECT-TYPESYNTAXStorageTypeMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The storage type for this conceptual row.
Conceptual rows having the value 'permanent' need not
allow write-access to any columnar objects in the row."DEFVAL{ nonVolatile }::={ pingCtlEntry 12}pingCtlTrapGeneration OBJECT-TYPE
SYNTAXBITS{probeFailure(0),testFailure(1),testCompletion(2)}MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object determines when and if
to generate a notification for this entry:
probeFailure(0) - Generate a pingProbeFailed
notification subject to the value of
pingCtlTrapProbeFailureFilter. The object
pingCtlTrapProbeFailureFilter can be used
to specify the number of successive probe failures
that are required before a pingProbeFailed
notification can be generated.
testFailure(1) - Generate a pingTestFailed
notification. In this instance the object
pingCtlTrapTestFailureFilter can be used to
determine the number of probe failures that
signal when a test fails.
testCompletion(2) - Generate a pingTestCompleted
notification.
The value of this object defaults to zero, indicating
that none of the above options have been selected."::={ pingCtlEntry 13}pingCtlTrapProbeFailureFilter OBJECT-TYPESYNTAXUnsigned32(0..15)MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object is used to determine when
to generate a pingProbeFailed NOTIFICATION.
Setting pingCtlTrapGeneration
to probeFailure(0) implies that a pingProbeFailed
NOTIFICATION is generated only when the number of
successive probe failures as indicated by the
value of pingCtlTrapPrbefailureFilter fail within
a given ping test."DEFVAL{1}::={ pingCtlEntry 14}pingCtlTrapTestFailureFilter OBJECT-TYPESYNTAXUnsigned32(0..15)MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object is used to determine when
to generate a pingTestFailed NOTIFICATION.
Setting pingCtlTrapGeneration to testFailure(1)
implies that a pingTestFailed NOTIFICATION is
generated only when the number of ping failures
within a test exceed the value of
pingCtlTrapTestFailureFilter."DEFVAL{1}::={ pingCtlEntry 15}pingCtlType OBJECT-TYPESYNTAXOBJECTIDENTIFIERMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object is used to either report or
select the implementation method to be used for
calculating a ping response time. The value of this
object MAY be selected from pingImplementationTypeDomains.
Additional implementation types SHOULD be allocated as
required by implementers of the DISMAN-PING-MIB under
their enterprise specific registration point and not
beneath pingImplementationTypeDomains."DEFVAL{ pingIcmpEcho }::={ pingCtlEntry 16}
pingCtlDescr OBJECT-TYPESYNTAXSnmpAdminStringMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The purpose of this object is to provide a
descriptive name of the remote ping test."DEFVAL{ '00'H }::={ pingCtlEntry 17}pingCtlSourceAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the type of the source address,
pingCtlSourceAddress, to be used at a remote host
when performing a ping operation."DEFVAL{ ipv4 }::={ pingCtlEntry 18}pingCtlSourceAddress OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Use the specified IP address (which must be given
in numeric form, not as a hostname) as the source
address in outgoing probe packets. On hosts with
more than one IP address, this option can be used
to force the source address to be something other
than the primary IP address of the interface the
probe packet is sent on. If the IP address is not
one of this machine's interface addresses, an error
is returned and nothing is sent. A zero length
octet string value for this object disables source
address specification.
The address type (InetAddressType) that relates to
this object is specified by the corresponding value
of pingCtlSourceAddressType."DEFVAL{ ''H }::={ pingCtlEntry 19}pingCtlIfIndex OBJECT-TYPESYNTAXInterfaceIndexOrZeroMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Setting this object to an interface's ifIndex prior
to starting a remote ping operation directs
the ping probes to be transmitted over the
specified interface. A value of zero for this object
means that this option is not enabled."DEFVAL{0}::={ pingCtlEntry 20}pingCtlByPassRouteTable OBJECT-TYPESYNTAXTruthValueMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The purpose of this object is to optionally enable
bypassing the route table. If enabled, the remote
host will bypass the normal routing tables and send
directly to a host on an attached network. If the
host is not on a directly-attached network, an
error is returned. This option can be used to perform
the ping operation to a local host through an
interface that has no route defined (e.g., after the
interface was dropped by routed)."DEFVAL{ false }::={ pingCtlEntry 21}pingCtlDSField OBJECT-TYPESYNTAXUnsigned32(0..255)
MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the value to store in the Differentiated
Services (DS) Field in the IP packet used to
encapsulate the ping probe. The DS Field is defined
as the Type of Service (TOS) octet in a IPv4 header
or as the Traffic Class octet in a IPv6 header.
The value of this object must be a decimal integer
in the range from 0 to 255. This option can be used
to determine what effect an explicit DS Field setting
has on a ping response. Not all values are legal or
meaningful. A value of 0 means that the function
represented by this option is not supported. DS Field
usage is often not supported by IP implementations and
not all values are supported. Refer to RFC 2474 for
guidance on usage of this field."REFERENCE"Refer to RFC 2474 for the definition of the
Differentiated Services Field and to RFC 1812
Section 5.3.2 for Type of Service (TOS)."DEFVAL{0}::={ pingCtlEntry 22}pingCtlRowStatus OBJECT-TYPESYNTAXRowStatusMAX-ACCESSread-createSTATUScurrentDESCRIPTION"This object allows entries to be created and deleted
in the pingCtlTable. Deletion of an entry in this
table results in all corresponding (same
pingCtlOwnerIndex and pingCtlTestName index values)
pingResultsTable and pingProbeHistoryTable entries
being deleted.
A value MUST be specified for pingCtlTargetAddress
prior to a transition to active(1) state being
accepted.
Activation of a remote ping operation is controlled
via pingCtlAdminStatus and not by changing
this object's value to active(1).
Transitions in and out of active(1) state are not
allowed while an entry's pingResultsOperStatus is
active(1) with the exception that deletion of
an entry in this table by setting its RowStatus
object to destroy(6) will stop an active
ping operation.
The operational state of a ping operation
can be determined by examination of its
pingResultsOperStatus object."REFERENCE"See definition of RowStatus in RFC 2579, 'Textual
Conventions for SMIv2.'"::={ pingCtlEntry 23}-- Ping Results TablepingResultsTable OBJECT-TYPESYNTAXSEQUENCEOF PingResultsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the Ping Results Table for providing
the capability of performing ping operations at
a remote host. The results of these operations are
stored in the pingResultsTable and the pingPastProbeTable.
An entry is added to the pingResultsTable when an
pingCtlEntry is started by successful transition
of its pingCtlAdminStatus object to enabled(1).
An entry is removed from the pingResultsTable when
its corresponding pingCtlEntry is deleted."::={ pingObjects 3}pingResultsEntry OBJECT-TYPESYNTAX PingResultsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the pingResultsTable. The
pingResultsTable has the same indexing as the
pingCtlTable in order for a pingResultsEntry to
correspond to the pingCtlEntry that caused it to
be created."INDEX{
pingCtlOwnerIndex,
pingCtlTestName
}
::={ pingResultsTable 1}
PingResultsEntry ::=SEQUENCE{
pingResultsOperStatus INTEGER,
pingResultsIpTargetAddressType InetAddressType,
pingResultsIpTargetAddress InetAddress,
pingResultsMinRtt Unsigned32,
pingResultsMaxRtt Unsigned32,
pingResultsAverageRtt Unsigned32,
pingResultsProbeResponses Unsigned32,
pingResultsSentProbes Unsigned32,
pingResultsRttSumOfSquares Unsigned32,
pingResultsLastGoodProbe DateAndTime}pingResultsOperStatus OBJECT-TYPESYNTAXINTEGER{enabled(1),-- test is in progressdisabled(2)-- test has stopped}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Reflects the operational state of a pingCtlEntry:
enabled(1) - Test is active.
disabled(2) - Test has stopped."::={ pingResultsEntry 1}pingResultsIpTargetAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-onlySTATUScurrent
DESCRIPTION"This objects indicates the type of address stored
in the corresponding pingResultsIpTargetAddress
object."DEFVAL{ unknown }::={ pingResultsEntry 2}pingResultsIpTargetAddress OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This objects reports the IP address associated
with a pingCtlTargetAddress value when the destination
address is specified as a DNS name. The value of
this object should be a zero length octet string
when a DNS name is not specified or when a
specified DNS name fails to resolve."DEFVAL{ ''H }::={ pingResultsEntry 3}pingResultsMinRtt OBJECT-TYPESYNTAXUnsigned32UNITS"milliseconds"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The minimum ping round-trip-time (RTT) received. A value
of 0 for this object implies that no RTT has been received."::={ pingResultsEntry 4}pingResultsMaxRtt OBJECT-TYPESYNTAXUnsigned32UNITS"milliseconds"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The maximum ping round-trip-time (RTT) received. A value
of 0 for this object implies that no RTT has been received."::={ pingResultsEntry 5}pingResultsAverageRtt OBJECT-TYPESYNTAXUnsigned32UNITS"milliseconds"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The current average ping round-trip-time (RTT)."::={ pingResultsEntry 6}pingResultsProbeResponses OBJECT-TYPESYNTAXUnsigned32UNITS"responses"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Number of responses received for the corresponding
pingCtlEntry and pingResultsEntry. The value of this object
MUST be reported as 0 when no probe responses have been
received."::={ pingResultsEntry 7}pingResultsSentProbes OBJECT-TYPESYNTAXUnsigned32UNITS"probes"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of this object reflects the number of probes sent
for the corresponding pingCtlEntry and pingResultsEntry.
The value of this object MUST be reported as 0 when no probes
have been sent."::={ pingResultsEntry 8}pingResultsRttSumOfSquares OBJECT-TYPESYNTAXUnsigned32
UNITS"milliseconds"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This object contains the sum of the squares for all ping
responses received. Its purpose is to enable standard
deviation calculation. The value of this object MUST
be reported as 0 when no ping responses have been
received."::={ pingResultsEntry 9}pingResultsLastGoodProbe OBJECT-TYPESYNTAXDateAndTimeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Date and time when the last response was received for
a probe."::={ pingResultsEntry 10}-- Ping Probe History TablepingProbeHistoryTable OBJECT-TYPESYNTAXSEQUENCEOF PingProbeHistoryEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines a table for storing the results of a ping
operation. Entries in this table are limited by
the value of the corresponding pingCtlMaxRows
object.
An entry in this table is created when the result of
a ping probe is determined. The initial 2 instance
identifier index values identify the pingCtlEntry
that a probe result (pingProbeHistoryEntry) belongs
to. An entry is removed from this table when
its corresponding pingCtlEntry is deleted.
An implementation of this MIB will remove the oldest
entry in the pingProbeHistoryTable to allow the
addition of an new entry once the number of rows in
the pingProbeHistoryTable reaches the value specified
by pingCtlMaxRows."::={ pingObjects 4}pingProbeHistoryEntry OBJECT-TYPESYNTAX PingProbeHistoryEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the pingProbeHistoryTable.
The first two index elements identify the
pingCtlEntry that a pingProbeHistoryEntry belongs
to. The third index element selects a single
probe result."INDEX{
pingCtlOwnerIndex,
pingCtlTestName,
pingProbeHistoryIndex
}::={ pingProbeHistoryTable 1}
PingProbeHistoryEntry ::=SEQUENCE{
pingProbeHistoryIndex Unsigned32,
pingProbeHistoryResponse Unsigned32,
pingProbeHistoryStatus OperationResponseStatus,
pingProbeHistoryLastRC Integer32,
pingProbeHistoryTime DateAndTime}pingProbeHistoryIndex OBJECT-TYPESYNTAXUnsigned32(1..'ffffffff'h)MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"An entry in this table is created when the result of
a ping probe is determined. The initial 2 instance
identifier index values identify the pingCtlEntry
that a probe result (pingProbeHistoryEntry) belongs
to.
An implementation MUST start assigning
pingProbeHistoryIndex values at 1 and wrap after
exceeding the maximum possible value as defined by
the limit of this object ('ffffffff'h)."::={ pingProbeHistoryEntry 1}pingProbeHistoryResponse OBJECT-TYPESYNTAXUnsigned32UNITS"milliseconds"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The amount of time measured in milliseconds from when
a probe was sent to when its response was received or
when it timed out. The value of this object is reported
as 0 when it is not possible to transmit a probe."::={ pingProbeHistoryEntry 2}pingProbeHistoryStatus OBJECT-TYPESYNTAXOperationResponseStatusMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The result of a particular probe done by a remote host."::={ pingProbeHistoryEntry 3}pingProbeHistoryLastRC OBJECT-TYPESYNTAXInteger32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The last implementation method specific reply code received.
If the ICMP Echo capability is being used then a successful
probe ends when an ICMP response is received that contains
the code ICMP_ECHOREPLY(0). The ICMP responses are defined
normally in the ip_icmp include file."::={ pingProbeHistoryEntry 4}
pingProbeHistoryTime OBJECT-TYPESYNTAXDateAndTimeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Timestamp for when this probe result was determined."::={ pingProbeHistoryEntry 5}-- Notification Definition sectionpingProbeFailed NOTIFICATION-TYPEOBJECTS{
pingCtlTargetAddressType,
pingCtlTargetAddress,
pingResultsOperStatus,
pingResultsIpTargetAddressType,
pingResultsIpTargetAddress,
pingResultsMinRtt,
pingResultsMaxRtt,
pingResultsAverageRtt,
pingResultsProbeResponses,
pingResultsSentProbes,
pingResultsRttSumOfSquares,
pingResultsLastGoodProbe
}STATUScurrentDESCRIPTION"Generated when a probe failure is detected when the
corresponding pingCtlTrapGeneration object is set to
probeFailure(0) subject to the value of
pingCtlTrapProbeFailureFilter. The object
pingCtlTrapProbeFailureFilter can be used to specify the
number of successive probe failures that are required
before this notification can be generated."::={ pingNotifications 1}pingTestFailed NOTIFICATION-TYPEOBJECTS{
pingCtlTargetAddressType,
pingCtlTargetAddress,
pingResultsOperStatus,
pingResultsIpTargetAddressType,
pingResultsIpTargetAddress,
pingResultsMinRtt,
pingResultsMaxRtt,
pingResultsAverageRtt,
pingResultsProbeResponses,
pingResultsSentProbes,
pingResultsRttSumOfSquares,
pingResultsLastGoodProbe
}STATUScurrentDESCRIPTION"Generated when a ping test is determined to have failed
when the corresponding pingCtlTrapGeneration object is
set to testFailure(1). In this instance
pingCtlTrapTestFailureFilter should specify the number of
probes in a test required to have failed in order to
consider the test as failed."::={ pingNotifications 2}pingTestCompleted NOTIFICATION-TYPEOBJECTS{
pingCtlTargetAddressType,
pingCtlTargetAddress,
pingResultsOperStatus,
pingResultsIpTargetAddressType,
pingResultsIpTargetAddress,
pingResultsMinRtt,
pingResultsMaxRtt,
pingResultsAverageRtt,
pingResultsProbeResponses,
pingResultsSentProbes,
pingResultsRttSumOfSquares,
pingResultsLastGoodProbe
}STATUScurrentDESCRIPTION"Generated at the completion of a ping test when the
corresponding pingCtlTrapGeneration object is set to
testCompletion(4)."::={ pingNotifications 3}-- Conformance information-- Compliance statementspingCompliances OBJECTIDENTIFIER::={ pingConformance 1}
pingGroups OBJECTIDENTIFIER::={ pingConformance 2}-- Compliance statementspingCompliance MODULE-COMPLIANCESTATUScurrentDESCRIPTION"The compliance statement for the DISMAN-PING-MIB."MODULE-- this moduleMANDATORY-GROUPS{
pingGroup,
pingNotificationsGroup
}GROUP pingTimeStampGroup
DESCRIPTION"This group is mandatory for implementations that have
access to a system clock and are capable of setting
the values for DateAndTime objects. It is RECOMMENDED
that when this group is not supported that the values
for the objects in this group be reported as
'0000000000000000'H."OBJECT pingMaxConcurrentRequests
MIN-ACCESSread-onlyDESCRIPTION"The agent is not required to support set
operations to this object."OBJECT pingCtlStorageType
MIN-ACCESSread-onlyDESCRIPTION"Write access is not required. It is also allowed
for implementations to support only the volatile
StorageType enumeration."OBJECT pingCtlType
MIN-ACCESSread-onlyDESCRIPTION"Write access is not required. In addition, the only
value that MUST be supported by an implementation is
pingIcmpEcho."OBJECT pingCtlByPassRouteTable
MIN-ACCESSread-onlyDESCRIPTION"This object is not required by implementations that
are not capable of its implementation. The function
represented by this object is implementable if the
setsockopt SOL_SOCKET SO_DONTROUTE option is
supported."OBJECT pingCtlSourceAddressType
SYNTAXInetAddressType{ unknown(0), ipv4(1), ipv6(2)}MIN-ACCESSread-onlyDESCRIPTION"This object is not required by implementations that
are not capable of binding the send socket with a
source address. An implementation is only required to
support IPv4 and IPv6 addresses."OBJECT pingCtlSourceAddress
SYNTAXInetAddress(SIZE(0|4|16))MIN-ACCESSread-onlyDESCRIPTION"This object is not required by implementations that
are not capable of binding the send socket with a
source address. An implementation is only required to
support IPv4 and globally unique IPv6 addresses."OBJECT pingCtlIfIndex
MIN-ACCESSread-onlyDESCRIPTION"Write access is not required. When write access is
not supported return a 0 as the value of this object.
A value of 0 means that the function represented by
this option is not supported."OBJECT pingCtlDSField
MIN-ACCESSread-only
DESCRIPTION"Write access is not required. When write access is
not supported return a 0 as the value of this object.
A value of 0 means that the function represented by
this option is not supported."OBJECT pingResultsIpTargetAddressType
SYNTAXInetAddressType{ unknown(0), ipv4(1), ipv6(2)}DESCRIPTION"An implementation is only required to
support IPv4 and IPv6 addresses."OBJECT pingResultsIpTargetAddress
SYNTAXInetAddress(SIZE(0|4|16))DESCRIPTION"An implementation is only required to
support IPv4 and globally unique IPv6 addresses."::={ pingCompliances 1}-- MIB groupingspingGroup OBJECT-GROUPOBJECTS{
pingMaxConcurrentRequests,
pingCtlTargetAddressType,
pingCtlTargetAddress,
pingCtlDataSize,
pingCtlTimeOut,
pingCtlProbeCount,
pingCtlAdminStatus,
pingCtlDataFill,
pingCtlFrequency,
pingCtlMaxRows,
pingCtlStorageType,
pingCtlTrapGeneration,
pingCtlTrapProbeFailureFilter,
pingCtlTrapTestFailureFilter,
pingCtlType,
pingCtlDescr,
pingCtlByPassRouteTable,
pingCtlSourceAddressType,
pingCtlSourceAddress,
pingCtlIfIndex,
pingCtlDSField,
pingCtlRowStatus,
pingResultsOperStatus,
pingResultsIpTargetAddressType,
pingResultsIpTargetAddress,
pingResultsMinRtt,
pingResultsMaxRtt,
pingResultsAverageRtt,
pingResultsProbeResponses,
pingResultsSentProbes,
pingResultsRttSumOfSquares,
pingProbeHistoryResponse,
pingProbeHistoryStatus,
pingProbeHistoryLastRC
}STATUScurrentDESCRIPTION"The group of objects that comprise the remote ping
capability."::={ pingGroups 1}pingTimeStampGroup OBJECT-GROUPOBJECTS{
pingResultsLastGoodProbe,
pingProbeHistoryTime
}STATUScurrentDESCRIPTION"The group of DateAndTime objects."::={ pingGroups 2}pingNotificationsGroup NOTIFICATION-GROUPNOTIFICATIONS{
pingProbeFailed,
pingTestFailed,
pingTestCompleted
}STATUScurrentDESCRIPTION
"The notification which are required to be supported by
implementations of this MIB."::={ pingGroups 3}ENDDISMAN-TRACEROUTE-MIB DEFINITIONS::=BEGINIMPORTSMODULE-IDENTITY,OBJECT-TYPE,Integer32,Gauge32,Unsigned32, mib-2,NOTIFICATION-TYPE,OBJECT-IDENTITYFROM SNMPv2-SMI -- RFC2578RowStatus,StorageType,TruthValue,DateAndTimeFROM SNMPv2-TC -- RFC2579MODULE-COMPLIANCE,OBJECT-GROUP,NOTIFICATION-GROUPFROM SNMPv2-CONF -- RFC2580SnmpAdminStringFROM SNMP-FRAMEWORK-MIB -- RFC2571InterfaceIndexOrZero-- RFC2863FROM IF-MIB
InetAddressType,InetAddressFROM INET-ADDRESS-MIB -- RFC2851OperationResponseStatusFROM DISMAN-PING-MIB;-- RFC2925traceRouteMIB MODULE-IDENTITYLAST-UPDATED"200009210000Z"-- 21 September 2000ORGANIZATION"IETF Distributed Management Working Group"
CONTACT-INFO"Kenneth White
International Business Machines Corporation
Network Computing Software Division
Research Triangle Park, NC, USA
E-mail: wkenneth@us.ibm.com"DESCRIPTION"The Traceroute MIB (DISMAN-TRACEROUTE-MIB) provides
access to the traceroute capability at a remote host."-- Revision historyREVISION"200009210000Z"-- 21 September 2000DESCRIPTION"Initial version, published as RFC 2925."::={ mib-2 81}-- Top level structure of the MIBtraceRouteNotifications OBJECTIDENTIFIER::={ traceRouteMIB 0}traceRouteObjects OBJECTIDENTIFIER::={ traceRouteMIB 1}traceRouteConformance OBJECTIDENTIFIER::={ traceRouteMIB 2}-- The registration node (point) for traceroute implementation typestraceRouteImplementationTypeDomains OBJECTIDENTIFIER::={ traceRouteMIB 3}traceRouteUsingUdpProbes OBJECT-IDENTITYSTATUScurrentDESCRIPTION"Indicates that an implementation is using UDP probes to
perform the traceroute operation."::={ traceRouteImplementationTypeDomains 1}-- Simple Object Definitions
traceRouteMaxConcurrentRequests OBJECT-TYPESYNTAXUnsigned32UNITS"requests"MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The maximum number of concurrent active traceroute requests
that are allowed within an agent implementation. A value
of 0 for this object implies that there is no limit for
the number of concurrent active requests in effect."DEFVAL{10}::={ traceRouteObjects 1}-- Traceroute Control TabletraceRouteCtlTable OBJECT-TYPESYNTAXSEQUENCEOF TraceRouteCtlEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the Remote Operations Traceroute Control Table for
providing the capability of invoking traceroute from a remote
host. The results of traceroute operations can be stored in
the traceRouteResultsTable, traceRouteProbeHistoryTable, and
the traceRouteHopsTable."::={ traceRouteObjects 2}traceRouteCtlEntry OBJECT-TYPESYNTAX TraceRouteCtlEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the traceRouteCtlTable. The first
index element, traceRouteCtlOwnerIndex, is of type
SnmpAdminString, a textual convention that allows for
use of the SNMPv3 View-Based Access Control Model
(RFC 2575 [11], VACM) and allows an management
application to identify its entries. The second index,
traceRouteCtlTestName (also an SnmpAdminString),
enables the same management application to have
multiple requests outstanding."INDEX{
traceRouteCtlOwnerIndex,
traceRouteCtlTestName
}::={ traceRouteCtlTable 1}
TraceRouteCtlEntry ::=SEQUENCE{
traceRouteCtlOwnerIndex SnmpAdminString,
traceRouteCtlTestName SnmpAdminString,
traceRouteCtlTargetAddressType InetAddressType,
traceRouteCtlTargetAddress InetAddress,
traceRouteCtlByPassRouteTable TruthValue,
traceRouteCtlDataSize Unsigned32,
traceRouteCtlTimeOut Unsigned32,
traceRouteCtlProbesPerHop Unsigned32,
traceRouteCtlPort Unsigned32,
traceRouteCtlMaxTtl Unsigned32,
traceRouteCtlDSField Unsigned32,
traceRouteCtlSourceAddressType InetAddressType,
traceRouteCtlSourceAddress InetAddress,
traceRouteCtlIfIndex InterfaceIndexOrZero,
traceRouteCtlMiscOptions SnmpAdminString,
traceRouteCtlMaxFailures Unsigned32,
traceRouteCtlDontFragment TruthValue,
traceRouteCtlInitialTtl Unsigned32,
traceRouteCtlFrequency Unsigned32,
traceRouteCtlStorageType StorageType,
traceRouteCtlAdminStatus INTEGER,
traceRouteCtlMaxRows Unsigned32,
traceRouteCtlTrapGeneration BITS,
traceRouteCtlDescr SnmpAdminString,
traceRouteCtlCreateHopsEntries TruthValue,
traceRouteCtlType OBJECTIDENTIFIER,
traceRouteCtlRowStatus RowStatus}traceRouteCtlOwnerIndex OBJECT-TYPESYNTAXSnmpAdminString(SIZE(0..32))MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"To facilitate the provisioning of access control by a
security administrator using the View-Based Access
Control Model (RFC 2575, VACM) for tables in which
multiple users may need to independently create or
modify entries, the initial index is used as an 'owner
index'. Such an initial index has a syntax of
SnmpAdminString, and can thus be trivially mapped to a
securityName or groupName as defined in VACM, in
accordance with a security policy.
When used in conjunction with such a security policy
all entries in the table belonging to a particular user
(or group) will have the same value for this initial
index. For a given user's entries in a particular
table, the object identifiers for the information in
these entries will have the same subidentifiers (except
for the 'column' subidentifier) up to the end of the
encoded owner index. To configure VACM to permit access
to this portion of the table, one would create
vacmViewTreeFamilyTable entries with the value of
vacmViewTreeFamilySubtree including the owner index
portion, and vacmViewTreeFamilyMask 'wildcarding' the
column subidentifier. More elaborate configurations
are possible."::={ traceRouteCtlEntry 1}traceRouteCtlTestName OBJECT-TYPESYNTAXSnmpAdminString(SIZE(0..32))MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"The name of a traceroute test. This is locally unique,
within the scope of an traceRouteCtlOwnerIndex."::={ traceRouteCtlEntry 2}traceRouteCtlTargetAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the type of host address to be used on the
traceroute request at the remote host."DEFVAL{ ipv4 }::={ traceRouteCtlEntry 3}traceRouteCtlTargetAddress OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the host address used on the
traceroute request at the remote host. The
host address type can be determined by the
examining the value of the corresponding
traceRouteCtlTargetAddressType index element.
A value for this object MUST be set prior to
transitioning its corresponding traceRouteCtlEntry to
active(1) via traceRouteCtlRowStatus."::={ traceRouteCtlEntry 4}traceRouteCtlByPassRouteTable OBJECT-TYPESYNTAXTruthValueMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The purpose of this object is to optionally enable
bypassing the route table. If enabled, the remote
host will bypass the normal routing tables and send
directly to a host on an attached network. If the
host is not on a directly-attached network, an
error is returned. This option can be used to perform
the traceroute operation to a local host through an
interface that has no route defined (e.g., after the
interface was dropped by routed)."DEFVAL{ false }::={ traceRouteCtlEntry 5}traceRouteCtlDataSize OBJECT-TYPESYNTAXUnsigned32(0..65507)UNITS"octets"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the size of the data portion of a traceroute
request in octets. A traceroute request is essentially
transmitted by encoding a UDP datagram into a
IP packet. So subtracting the size of a UDP header
(8 octets) and the size of a IP header (20 octets)
yields a maximum of 65507 octets."DEFVAL{0}::={ traceRouteCtlEntry 6}traceRouteCtlTimeOut OBJECT-TYPESYNTAXUnsigned32(1..60)
UNITS"seconds"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the time-out value, in seconds, for
a traceroute request."DEFVAL{3}::={ traceRouteCtlEntry 7}traceRouteCtlProbesPerHop OBJECT-TYPESYNTAXUnsigned32(1..10)UNITS"probes"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the number of times to reissue a traceroute
request with the same time-to-live (TTL) value."DEFVAL{3}::={ traceRouteCtlEntry 8}traceRouteCtlPort OBJECT-TYPESYNTAXUnsigned32(1..65535)UNITS"UDP Port"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the UDP port to send the traceroute
request to. Need to specify a port that is not in
use at the destination (target) host. The default
value for this object is the IANA assigned port,
33434, for the traceroute function."
DEFVAL{33434}::={ traceRouteCtlEntry 9}traceRouteCtlMaxTtl OBJECT-TYPESYNTAXUnsigned32(1..255)UNITS"time-to-live value"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the maximum time-to-live value."DEFVAL{30}::={ traceRouteCtlEntry 10}traceRouteCtlDSField OBJECT-TYPESYNTAXUnsigned32(0..255)MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the value to store in the Differentiated
Services (DS) Field in the IP packet used to
encapsulate the traceroute probe. The DS Field is
defined as the Type of Service (TOS) octet in a IPv4
header or as the Traffic Class octet in a IPv6 header.
The value of this object must be a decimal integer
in the range from 0 to 255. This option can be used
to determine what effect an explicit DS Field setting
has on a traceroute response. Not all values are legal
or meaningful. DS Field usage is often not supported
by IP implementations. A value of 0 means that the
function represented by this option is not supported.
Useful TOS octet values are probably '16' (low delay)
and '8' ( high throughput)."REFERENCE"Refer to RFC 2474 for the definition of the
Differentiated Services Field and to RFC 1812
Section 5.3.2 for Type of Service (TOS)."DEFVAL{0}::={ traceRouteCtlEntry 11}traceRouteCtlSourceAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the type of the source address,
traceRouteCtlSourceAddress, to be used at a remote host
when performing a traceroute operation."DEFVAL{ unknown }::={ traceRouteCtlEntry 12}traceRouteCtlSourceAddress OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Use the specified IP address (which must be given
as an IP number, not a hostname) as the source
address in outgoing probe packets. On hosts with
more than one IP address, this option can be used
to force the source address to be something other
than the primary IP address of the interface the
probe packet is sent on. If the IP address is not
one of this machine's interface addresses, an error
is returned and nothing is sent. A zero length
octet string value for this object disables source
address specification.
The address type (InetAddressType) that relates to
this object is specified by the corresponding value
of traceRouteCtlSourceAddressType."DEFVAL{ ''H }::={ traceRouteCtlEntry 13}traceRouteCtlIfIndex OBJECT-TYPESYNTAXInterfaceIndexOrZeroMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Setting this object to an interface's ifIndex prior
to starting a remote traceroute operation directs
the traceroute probes to be transmitted over the
specified interface. A value of zero for this object
implies that this option is not enabled."DEFVAL{0}::={ traceRouteCtlEntry 14}traceRouteCtlMiscOptions OBJECT-TYPESYNTAXSnmpAdminStringMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Enables an application to specify implementation
dependent options."DEFVAL{ ''H }::={ traceRouteCtlEntry 15}traceRouteCtlMaxFailures OBJECT-TYPESYNTAXUnsigned32(0..255)UNITS"timeouts"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object indicates the maximum number
of consecutive timeouts allowed before terminating
a remote traceroute request. A value of either 255 (maximum
hop count/possible TTL value) or a 0 indicates that the
function of terminating a remote traceroute request when a
specific number of successive timeouts are detected is
disabled."DEFVAL{5}::={ traceRouteCtlEntry 16}traceRouteCtlDontFragment OBJECT-TYPESYNTAXTruthValueMAX-ACCESSread-createSTATUScurrentDESCRIPTION"This object enables setting of the don't fragment flag (DF)
in the IP header for a probe. Use of this object enables
performing a manual PATH MTU test."DEFVAL{ false }::={ traceRouteCtlEntry 17}traceRouteCtlInitialTtl OBJECT-TYPESYNTAXUnsigned32(0..255)MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object specifies the initial TTL value to
use. This enables bypassing the initial (often well known)
portion of a path."DEFVAL{1}::={ traceRouteCtlEntry 18}traceRouteCtlFrequency OBJECT-TYPESYNTAXUnsigned32UNITS"seconds"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The number of seconds to wait before repeating a
traceroute test as defined by the value of the
various objects in the corresponding row.
The number of hops in a single traceroute test
is determined by the value of the corresponding
traceRouteCtlProbesPerHop object. After a
single test completes the number of seconds as defined
by the value of traceRouteCtlFrequency MUST elapse
before the next traceroute test is started.
A value of 0 for this object implies that the test
as defined by the corresponding entry will not be
repeated."DEFVAL{0}::={ traceRouteCtlEntry 19}traceRouteCtlStorageType OBJECT-TYPESYNTAXStorageTypeMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The storage type for this conceptual row.
Conceptual rows having the value 'permanent' need not
allow write-access to any columnar objects in the row."DEFVAL{ nonVolatile }::={ traceRouteCtlEntry 20}traceRouteCtlAdminStatus OBJECT-TYPESYNTAXINTEGER{enabled(1),-- operation should be starteddisabled(2)-- operation should be stopped}MAX-ACCESSread-createSTATUScurrentDESCRIPTION"Reflects the desired state that an traceRouteCtlEntry
should be in:
enabled(1) - Attempt to activate the test as defined by
this traceRouteCtlEntry.
disabled(2) - Deactivate the test as defined by this
traceRouteCtlEntry.
Refer to the corresponding traceRouteResultsOperStatus to
determine the operational state of the test defined by
this entry."DEFVAL{ disabled }::={ traceRouteCtlEntry 21}traceRouteCtlDescr OBJECT-TYPESYNTAXSnmpAdminStringMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The purpose of this object is to provide a
descriptive name of the remote traceroute
test."DEFVAL{ '00'H }::={ traceRouteCtlEntry 22}traceRouteCtlMaxRows OBJECT-TYPESYNTAXUnsigned32UNITS"rows"MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The maximum number of entries allowed in the
traceRouteProbeHistoryTable. An implementation of
this MIB will remove the oldest entry in the
traceRouteProbeHistoryTable to allow the addition
of an new entry once the number of rows in the
traceRouteProbeHistoryTable reaches this value.
Old entries are not removed when a new test is
started. Entries are added to the
traceRouteProbeHistoryTable until traceRouteCtlMaxRows
is reached before entries begin to be removed.
A value of 0 for this object disables creation of
traceRouteProbeHistoryTable entries."DEFVAL{50}::={ traceRouteCtlEntry 23}
traceRouteCtlTrapGeneration OBJECT-TYPESYNTAXBITS{pathChange(0),testFailure(1),testCompletion(2)}MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object determines when and if to
to generate a notification for this entry:
pathChange(0) - Generate a traceRoutePathChange
notification when the current path varies from a
previously determined path.
testFailure(1) - Generate a traceRouteTestFailed
notification when the full path to a target
can't be determined.
testCompletion(2) - Generate a traceRouteTestCompleted
notification when the path to a target has been
determined.
The value of this object defaults to zero, indicating
that none of the above options have been selected."::={ traceRouteCtlEntry 24}traceRouteCtlCreateHopsEntries OBJECT-TYPESYNTAXTruthValueMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The current path for a traceroute test is kept in the
traceRouteHopsTable on a per hop basis when the value of
this object is true(1)."DEFVAL{ false }::={ traceRouteCtlEntry 25}traceRouteCtlType OBJECT-TYPESYNTAXOBJECTIDENTIFIER
MAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object is used either to report or
select the implementation method to be used for
performing a traceroute operation. The value of this
object may be selected from
traceRouteImplementationTypeDomains.
Additional implementation types should be allocated as
required by implementers of the DISMAN-TRACEROUTE-MIB
under their enterprise specific registration point and
not beneath traceRouteImplementationTypeDomains."DEFVAL{ traceRouteUsingUdpProbes }::={ traceRouteCtlEntry 26}traceRouteCtlRowStatus OBJECT-TYPESYNTAXRowStatusMAX-ACCESSread-createSTATUScurrentDESCRIPTION"This object allows entries to be created and deleted
in the traceRouteCtlTable. Deletion of an entry in
this table results in all corresponding (same
traceRouteCtlOwnerIndex and traceRouteCtlTestName
index values) traceRouteResultsTable,
traceRouteProbeHistoryTable, and traceRouteHopsTable
entries being deleted.
A value MUST be specified for traceRouteCtlTargetAddress
prior to a transition to active(1) state being
accepted.
Activation of a remote traceroute operation is
controlled via traceRouteCtlAdminStatus and not
by transitioning of this object's value to active(1).
Transitions in and out of active(1) state are not
allowed while an entry's traceRouteResultsOperStatus
is active(1) with the exception that deletion of
an entry in this table by setting its RowStatus
object to destroy(6) will stop an active
traceroute operation.
The operational state of an traceroute operation
can be determined by examination of the corresponding
traceRouteResultsOperStatus object."
REFERENCE"See definition of RowStatus in RFC 2579, 'Textual
Conventions for SMIv2.'"::={ traceRouteCtlEntry 27}-- Traceroute Results TabletraceRouteResultsTable OBJECT-TYPESYNTAXSEQUENCEOF TraceRouteResultsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the Remote Operations Traceroute Results Table for
keeping track of the status of a traceRouteCtlEntry.
An entry is added to the traceRouteResultsTable when an
traceRouteCtlEntry is started by successful transition
of its traceRouteCtlAdminStatus object to enabled(1).
An entry is removed from the traceRouteResultsTable when
its corresponding traceRouteCtlEntry is deleted."::={ traceRouteObjects 3}traceRouteResultsEntry OBJECT-TYPESYNTAX TraceRouteResultsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the traceRouteResultsTable. The
traceRouteResultsTable has the same indexing as the
traceRouteCtlTable in order for a traceRouteResultsEntry
to correspond to the traceRouteCtlEntry that caused it to
be created."INDEX{
traceRouteCtlOwnerIndex,
traceRouteCtlTestName
}::={ traceRouteResultsTable 1}
TraceRouteResultsEntry ::=SEQUENCE{
traceRouteResultsOperStatus INTEGER,
traceRouteResultsCurHopCount Gauge32,
traceRouteResultsCurProbeCount Gauge32,
traceRouteResultsIpTgtAddrType InetAddressType,
traceRouteResultsIpTgtAddr InetAddress,
traceRouteResultsTestAttempts Unsigned32,
traceRouteResultsTestSuccesses Unsigned32,
traceRouteResultsLastGoodPath DateAndTime}traceRouteResultsOperStatus OBJECT-TYPESYNTAXINTEGER{enabled(1),-- test is in progressdisabled(2)-- test has stopped}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Reflects the operational state of an traceRouteCtlEntry:
enabled(1) - Test is active.
disabled(2) - Test has stopped."::={ traceRouteResultsEntry 1}traceRouteResultsCurHopCount OBJECT-TYPESYNTAXGauge32UNITS"hops"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Reflects the current TTL value (range from 1 to
255) for a remote traceroute operation.
Maximum TTL value is determined by
traceRouteCtlMaxTtl."::={ traceRouteResultsEntry 2}
traceRouteResultsCurProbeCount OBJECT-TYPESYNTAXGauge32UNITS"probes"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Reflects the current probe count (1..10) for
a remote traceroute operation. The maximum
probe count is determined by
traceRouteCtlProbesPerHop."::={ traceRouteResultsEntry 3}traceRouteResultsIpTgtAddrType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This objects indicates the type of address stored
in the corresponding traceRouteResultsIpTgtAddr
object."::={ traceRouteResultsEntry 4}traceRouteResultsIpTgtAddr OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This objects reports the IP address associated
with a traceRouteCtlTargetAddress value when the
destination address is specified as a DNS name.
The value of this object should be a zero length
octet string when a DNS name is not specified or
when a specified DNS name fails to resolve."::={ traceRouteResultsEntry 5}traceRouteResultsTestAttempts OBJECT-TYPESYNTAXUnsigned32UNITS"tests"MAX-ACCESSread-only
STATUScurrentDESCRIPTION"The current number of attempts to determine a path
to a target. The value of this object MUST be started
at 0."::={ traceRouteResultsEntry 6}traceRouteResultsTestSuccesses OBJECT-TYPESYNTAXUnsigned32UNITS"tests"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The current number of attempts to determine a path
to a target that have succeeded. The value of this
object MUST be reported as 0 when no attempts have
succeeded."::={ traceRouteResultsEntry 7}traceRouteResultsLastGoodPath OBJECT-TYPESYNTAXDateAndTimeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The date and time when the last complete path
was determined."::={ traceRouteResultsEntry 8}-- Trace Route Probe History TabletraceRouteProbeHistoryTable OBJECT-TYPESYNTAXSEQUENCEOF TraceRouteProbeHistoryEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the Remote Operations Traceroute Results Table for
storing the results of a traceroute operation.
An implementation of this MIB will remove the oldest
entry in the traceRouteProbeHistoryTable to allow the
addition of an new entry once the number of rows in
the traceRouteProbeHistoryTable reaches the value specified
by traceRouteCtlMaxRows."::={ traceRouteObjects 4}traceRouteProbeHistoryEntry OBJECT-TYPESYNTAX TraceRouteProbeHistoryEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines a table for storing the results of a traceroute
operation. Entries in this table are limited by
the value of the corresponding traceRouteCtlMaxRows
object.
The first two index elements identify the
traceRouteCtlEntry that a traceRouteProbeHistoryEntry
belongs to. The third index element selects a single
traceroute operation result. The fourth and fifth indexes
select the hop and the probe for a particular
traceroute operation."INDEX{
traceRouteCtlOwnerIndex,
traceRouteCtlTestName,
traceRouteProbeHistoryIndex,
traceRouteProbeHistoryHopIndex,
traceRouteProbeHistoryProbeIndex
}::={ traceRouteProbeHistoryTable 1}
TraceRouteProbeHistoryEntry ::=SEQUENCE{
traceRouteProbeHistoryIndex Unsigned32,
traceRouteProbeHistoryHopIndex Unsigned32,
traceRouteProbeHistoryProbeIndex Unsigned32,
traceRouteProbeHistoryHAddrType InetAddressType,
traceRouteProbeHistoryHAddr InetAddress,
traceRouteProbeHistoryResponse Unsigned32,
traceRouteProbeHistoryStatus OperationResponseStatus,
traceRouteProbeHistoryLastRC Integer32,
traceRouteProbeHistoryTime DateAndTime}traceRouteProbeHistoryIndex OBJECT-TYPESYNTAXUnsigned32(1..'ffffffff'h)MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"An entry in this table is created when the result of
a traceroute probe is determined. The initial 2 instance
identifier index values identify the traceRouteCtlEntry
that a probe result (traceRouteProbeHistoryEntry) belongs
to. An entry is removed from this table when
its corresponding traceRouteCtlEntry is deleted.
An implementation MUST start assigning
traceRouteProbeHistoryIndex values at 1 and wrap after
exceeding the maximum possible value as defined by the
limit of this object ('ffffffff'h)."::={ traceRouteProbeHistoryEntry 1}traceRouteProbeHistoryHopIndex OBJECT-TYPESYNTAXUnsigned32(1..255)MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Indicates which hop in a traceroute path that the probe's
results are for. The value of this object is initially
determined by the value of traceRouteCtlInitialTtl."::={ traceRouteProbeHistoryEntry 2}traceRouteProbeHistoryProbeIndex OBJECT-TYPESYNTAXUnsigned32(1..10)
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Indicates the index of a probe for a particular
hop in a traceroute path. The number of probes per
hop is determined by the value of the corresponding
traceRouteCtlProbesPerHop object."::={ traceRouteProbeHistoryEntry 3}traceRouteProbeHistoryHAddrType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This objects indicates the type of address stored
in the corresponding traceRouteProbeHistoryHAddr
object."::={ traceRouteProbeHistoryEntry 4}traceRouteProbeHistoryHAddr OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The address of a hop in a traceroute path. This object
is not allowed to be a DNS name. The value of the
corresponding object, traceRouteProbeHistoryHAddrType,
indicates this object's IP address type."::={ traceRouteProbeHistoryEntry 5}traceRouteProbeHistoryResponse OBJECT-TYPESYNTAXUnsigned32UNITS"milliseconds"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The amount of time measured in milliseconds from when
a probe was sent to when its response was received or
when it timed out. The value of this object is reported
as 0 when it is not possible to transmit a probe."::={ traceRouteProbeHistoryEntry 6}traceRouteProbeHistoryStatus OBJECT-TYPESYNTAXOperationResponseStatusMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The result of a traceroute operation made by a remote
host for a particular probe."::={ traceRouteProbeHistoryEntry 7}traceRouteProbeHistoryLastRC OBJECT-TYPESYNTAXInteger32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The last implementation method specific reply code received.
Traceroute is usually implemented by transmitting a series of
probe packets with increasing time-to-live values. A probe
packet is a UDP datagram encapsulated into an IP packet.
Each hop in a path to the target (destination) host rejects
the probe packets (probe's TTL too small, ICMP reply) until
either the maximum TTL is exceeded or the target host is
received."::={ traceRouteProbeHistoryEntry 8}traceRouteProbeHistoryTime OBJECT-TYPESYNTAXDateAndTimeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Timestamp for when this probe results were determined."::={ traceRouteProbeHistoryEntry 9}
-- Traceroute Hop Results TabletraceRouteHopsTable OBJECT-TYPESYNTAXSEQUENCEOF TraceRouteHopsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the Remote Operations Traceroute Hop Table for
keeping track of the results of traceroute tests on a
per hop basis."::={ traceRouteObjects 5}traceRouteHopsEntry OBJECT-TYPESYNTAX TraceRouteHopsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the traceRouteHopsTable.
The first two index elements identify the
traceRouteCtlEntry that a traceRouteHopsEntry
belongs to. The third index element,
traceRouteHopsHopIndex, selects a
hop in a traceroute path."INDEX{
traceRouteCtlOwnerIndex,
traceRouteCtlTestName,
traceRouteHopsHopIndex
}::={ traceRouteHopsTable 1}
TraceRouteHopsEntry ::=SEQUENCE{
traceRouteHopsHopIndex Unsigned32,
traceRouteHopsIpTgtAddressType InetAddressType,
traceRouteHopsIpTgtAddress InetAddress,
traceRouteHopsMinRtt Unsigned32,
traceRouteHopsMaxRtt Unsigned32,
traceRouteHopsAverageRtt Unsigned32,
traceRouteHopsRttSumOfSquares Unsigned32,
traceRouteHopsSentProbes Unsigned32,
traceRouteHopsProbeResponses Unsigned32,
traceRouteHopsLastGoodProbe DateAndTime}traceRouteHopsHopIndex OBJECT-TYPESYNTAXUnsigned32MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Specifies the hop index for a traceroute hop. Values
for this object with respect to the same
traceRouteCtlOwnerIndex and traceRouteCtlTestName
MUST start at 1 and increase monotonically.
The traceRouteHopsTable keeps the current traceroute
path per traceRouteCtlEntry if enabled by
setting the corresponding traceRouteCtlCreateHopsEntries
to true(1).
All hops (traceRouteHopsTable entries) in a traceroute
path MUST be updated at the same time when a traceroute
operation completes. Care needs to be applied when either
a path changes or can't be determined. The initial portion
of the path, up to the first hop change, MUST retain the
same traceRouteHopsHopIndex values. The remaining portion
of the path SHOULD be assigned new traceRouteHopsHopIndex
values."::={ traceRouteHopsEntry 1}traceRouteHopsIpTgtAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This objects indicates the type of address stored
in the corresponding traceRouteHopsIpTargetAddress
object."::={ traceRouteHopsEntry 2}traceRouteHopsIpTgtAddress OBJECT-TYPESYNTAXInetAddress
MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This object reports the IP address associated with
the hop. A value for this object should be reported
as a numeric IP address and not as a DNS name."::={ traceRouteHopsEntry 3}traceRouteHopsMinRtt OBJECT-TYPESYNTAXUnsigned32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The minimum traceroute round-trip-time (RTT) received for
this hop. A value of 0 for this object implies that no
RTT has been received."::={ traceRouteHopsEntry 4}traceRouteHopsMaxRtt OBJECT-TYPESYNTAXUnsigned32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The maximum traceroute round-trip-time (RTT) received for
this hop. A value of 0 for this object implies that no
RTT has been received."::={ traceRouteHopsEntry 5}traceRouteHopsAverageRtt OBJECT-TYPESYNTAXUnsigned32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The current average traceroute round-trip-time (RTT) for
this hop."::={ traceRouteHopsEntry 6}traceRouteHopsRttSumOfSquares OBJECT-TYPE
SYNTAXUnsigned32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This object contains the sum of all traceroute responses
received for this hop. Its purpose is to enable standard
deviation calculation."::={ traceRouteHopsEntry 7}traceRouteHopsSentProbes OBJECT-TYPESYNTAXUnsigned32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of this object reflects the number of probes sent
for this hop during this traceroute test. The value of this
object should start at 0."::={ traceRouteHopsEntry 8}traceRouteHopsProbeResponses OBJECT-TYPESYNTAXUnsigned32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Number of responses received for this hop during this
traceroute test. This value of this object should start
at 0."::={ traceRouteHopsEntry 9}traceRouteHopsLastGoodProbe OBJECT-TYPESYNTAXDateAndTimeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Date and time was the last response was received for a probe
for this hop during this traceroute test."::={ traceRouteHopsEntry 10}-- Notification Definition sectiontraceRoutePathChange NOTIFICATION-TYPEOBJECTS{
traceRouteCtlTargetAddressType,
traceRouteCtlTargetAddress,
traceRouteResultsIpTgtAddrType,
traceRouteResultsIpTgtAddr
}STATUScurrentDESCRIPTION"The path to a target has changed."::={ traceRouteNotifications 1}traceRouteTestFailed NOTIFICATION-TYPEOBJECTS{
traceRouteCtlTargetAddressType,
traceRouteCtlTargetAddress,
traceRouteResultsIpTgtAddrType,
traceRouteResultsIpTgtAddr
}STATUScurrentDESCRIPTION"Could not determine the path to a target."::={ traceRouteNotifications 2}traceRouteTestCompleted NOTIFICATION-TYPEOBJECTS{
traceRouteCtlTargetAddressType,
traceRouteCtlTargetAddress,
traceRouteResultsIpTgtAddrType,
traceRouteResultsIpTgtAddr
}STATUScurrentDESCRIPTION"The path to a target has just been determined."::={ traceRouteNotifications 3}-- Conformance information-- Compliance statementstraceRouteCompliances OBJECTIDENTIFIER::={ traceRouteConformance 1}
traceRouteGroups OBJECTIDENTIFIER::={ traceRouteConformance 2}-- Compliance statementstraceRouteCompliance MODULE-COMPLIANCESTATUScurrentDESCRIPTION"The compliance statement for the DISMAN-TRACEROUTE-MIB."MODULE-- this moduleMANDATORY-GROUPS{
traceRouteGroup
}GROUP traceRouteTimeStampGroup
DESCRIPTION"This group is mandatory for implementations that have
access to a system clock and are capable of setting
the values for DateAndTime objects."GROUP traceRouteNotificationsGroup
DESCRIPTION"This group defines a collection of optional
notifications."GROUP traceRouteHopsTableGroup
DESCRIPTION"This group lists the objects that make up a
traceRouteHopsEntry. Support of the traceRouteHopsTable
is optional."OBJECT traceRouteMaxConcurrentRequests
MIN-ACCESSread-onlyDESCRIPTION"The agent is not required to support SET
operations to this object."OBJECT traceRouteCtlByPassRouteTable
MIN-ACCESSread-onlyDESCRIPTION"This object is not required by implementations that
are not capable of its implementation. The function
represented by this object is implementable if the
setsockopt SOL_SOCKET SO_DONTROUTE option is
supported."OBJECT traceRouteCtlSourceAddressType
SYNTAXInetAddressType{ unknown(0), ipv4(1), ipv6(2)}MIN-ACCESSread-onlyDESCRIPTION"This object is not required by implementations that
are not capable of binding the send socket with a
source address. An implementation is only required to
support IPv4 and IPv6 addresses."OBJECT traceRouteCtlSourceAddress
SYNTAXInetAddress(SIZE(0|4|16))MIN-ACCESSread-onlyDESCRIPTION"This object is not required by implementations that
are not capable of binding the send socket with a
source address. An implementation is only required to
support IPv4 and globally unique IPv6 addresses."OBJECT traceRouteCtlIfIndex
MIN-ACCESSread-onlyDESCRIPTION"Write access is not required. When write access is
not supported return a 0 as the value of this object.
A value of 0 implies that the function represented by
this option is not supported."OBJECT traceRouteCtlMiscOptions
MIN-ACCESSread-onlyDESCRIPTION"Support of this object is optional. When not
supporting do not allow write access and return a
zero length octet string as the value of the object."OBJECT traceRouteCtlStorageType
MIN-ACCESSread-only
DESCRIPTION"Write access is not required. It is also allowed
for implementations to support only the volatile
StorageType enumeration."OBJECT traceRouteCtlDSField
MIN-ACCESSread-onlyDESCRIPTION"Write access is not required. When write access is
not supported return a 0 as the value of this object.
A value of 0 implies that the function represented by
this option is not supported."OBJECT traceRouteCtlType
MIN-ACCESSread-onlyDESCRIPTION"Write access is not required. In addition, the only
value that is RECOMMENDED to be supported by an
implementation is traceRouteUsingUdpProbes."OBJECT traceRouteResultsIpTgtAddrType
SYNTAXInetAddressType{ unknown(0), ipv4(1), ipv6(2)}DESCRIPTION"An implementation should only support IPv4 and
globally unique IPv6 address values for this object."OBJECT traceRouteResultsIpTgtAddr
SYNTAXInetAddress(SIZE(0|4|16))DESCRIPTION"An implementation should only support IPv4 and
globally unique IPv6 address values for this object."OBJECT traceRouteProbeHistoryHAddrType
SYNTAXInetAddressType{ unknown(0), ipv4(1), ipv6(2)}
DESCRIPTION"An implementation should only support IPv4 and
globally unique IPv6 address values for this object."OBJECT traceRouteProbeHistoryHAddr
SYNTAXInetAddress(SIZE(0|4|16))DESCRIPTION"An implementation should only support IPv4 and
globally unique IPv6 address values for this object."OBJECT traceRouteHopsIpTgtAddressType
SYNTAXInetAddressType{ unknown(0), ipv4(1), ipv6(2)}DESCRIPTION"An implementation should only support IPv4 and
globally unique IPv6 address values for this object."OBJECT traceRouteHopsIpTgtAddress
SYNTAXInetAddress(SIZE(0|4|16))DESCRIPTION"An implementation should only support IPv4 and
globally unique IPv6 address values for this object."::={ traceRouteCompliances 1}-- MIB groupingstraceRouteGroup OBJECT-GROUPOBJECTS{
traceRouteMaxConcurrentRequests,
traceRouteCtlTargetAddressType,
traceRouteCtlTargetAddress,
traceRouteCtlByPassRouteTable,
traceRouteCtlDataSize,
traceRouteCtlTimeOut,
traceRouteCtlProbesPerHop,
traceRouteCtlPort,
traceRouteCtlMaxTtl,
traceRouteCtlDSField,
traceRouteCtlSourceAddressType,
traceRouteCtlSourceAddress,
traceRouteCtlIfIndex,
traceRouteCtlMiscOptions,
traceRouteCtlMaxFailures,
traceRouteCtlDontFragment,
traceRouteCtlInitialTtl,
traceRouteCtlFrequency,
traceRouteCtlStorageType,
traceRouteCtlAdminStatus,
traceRouteCtlMaxRows,
traceRouteCtlTrapGeneration,
traceRouteCtlDescr,
traceRouteCtlCreateHopsEntries,
traceRouteCtlType,
traceRouteCtlRowStatus,
traceRouteResultsOperStatus,
traceRouteResultsCurHopCount,
traceRouteResultsCurProbeCount,
traceRouteResultsIpTgtAddrType,
traceRouteResultsIpTgtAddr,
traceRouteResultsTestAttempts,
traceRouteResultsTestSuccesses,
traceRouteProbeHistoryHAddrType,
traceRouteProbeHistoryHAddr,
traceRouteProbeHistoryResponse,
traceRouteProbeHistoryStatus,
traceRouteProbeHistoryLastRC
}STATUScurrentDESCRIPTION"The group of objects that comprise the remote traceroute
operation."::={ traceRouteGroups 1}
traceRouteTimeStampGroup OBJECT-GROUPOBJECTS{
traceRouteResultsLastGoodPath,
traceRouteProbeHistoryTime
}STATUScurrentDESCRIPTION"The group of DateAndTime objects."::={ traceRouteGroups 2}traceRouteNotificationsGroup NOTIFICATION-GROUPNOTIFICATIONS{
traceRoutePathChange,
traceRouteTestFailed,
traceRouteTestCompleted
}STATUScurrentDESCRIPTION"The notifications which are required to be supported by
implementations of this MIB."::={ traceRouteGroups 3}traceRouteHopsTableGroup OBJECT-GROUPOBJECTS{
traceRouteHopsIpTgtAddressType,
traceRouteHopsIpTgtAddress,
traceRouteHopsMinRtt,
traceRouteHopsMaxRtt,
traceRouteHopsAverageRtt,
traceRouteHopsRttSumOfSquares,
traceRouteHopsSentProbes,
traceRouteHopsProbeResponses,
traceRouteHopsLastGoodProbe
}STATUScurrentDESCRIPTION"The group of objects that comprise the traceRouteHopsTable."::={ traceRouteGroups 4}ENDDISMAN-NSLOOKUP-MIB DEFINITIONS::=BEGIN
IMPORTSMODULE-IDENTITY,OBJECT-TYPE,Unsigned32, mib-2,Integer32FROM SNMPv2-SMI -- RFC2578RowStatusFROM SNMPv2-TC -- RFC2579MODULE-COMPLIANCE,OBJECT-GROUPFROM SNMPv2-CONF -- RFC2580SnmpAdminStringFROM SNMP-FRAMEWORK-MIB -- RFC2571InetAddressType,InetAddressFROM INET-ADDRESS-MIB;-- RFC2851lookupMIB MODULE-IDENTITYLAST-UPDATED"200009210000Z"-- 21 September 2000ORGANIZATION"IETF Distributed Management Working Group"CONTACT-INFO"Kenneth White
International Business Machines Corporation
Network Computing Software Division
Research Triangle Park, NC, USA
E-mail: wkenneth@us.ibm.com"DESCRIPTION"The Lookup MIB (DISMAN-NSLOOKUP-MIB) enables determination
of either the name(s) corresponding to a host address or of
the address(es) associated with a host name at a remote host."-- Revision historyREVISION"200009210000Z"-- 21 September 2000DESCRIPTION"Initial version, published as RFC 2925."::={ mib-2 82}-- Top level structure of the MIB
lookupObjects OBJECTIDENTIFIER::={ lookupMIB 1}lookupConformance OBJECTIDENTIFIER::={ lookupMIB 2}-- Simple Object DefinitionslookupMaxConcurrentRequests OBJECT-TYPESYNTAXUnsigned32UNITS"requests"MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The maximum number of concurrent active lookup requests
that are allowed within an agent implementation. A value
of 0 for this object implies that there is no limit for
the number of concurrent active requests in effect."DEFVAL{10}::={ lookupObjects 1}lookupPurgeTime OBJECT-TYPESYNTAXUnsigned32(0..86400)UNITS"seconds"MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"The amount of time to wait before automatically
deleting an entry in the lookupCtlTable and any
dependent lookupResultsTable entries
after the lookup operation represented by an
lookupCtlEntry has completed.
An lookupCtEntry is considered complete
when its lookupCtlOperStatus object has a
value of completed(3)."DEFVAL{900}-- 15 minutes as default
::={ lookupObjects 2}-- Lookup Control TablelookupCtlTable OBJECT-TYPESYNTAXSEQUENCEOF LookupCtlEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the Lookup Control Table for providing
the capability of performing a lookup operation,
gethostbyname or gethostbyaddr, from a remote host."::={ lookupObjects 3}lookupCtlEntry OBJECT-TYPESYNTAX LookupCtlEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the lookupCtlTable. A
lookupCtlEntry is initially indexed by
lookupCtlOwnerIndex, which is of type SnmpAdminString,
a textual convention that allows for use of the SNMPv3
View-Based Access Control Model (RFC 2575 [11], VACM)
and also allows an management application to identify
its entries. The second index element,
lookupCtlOperationName, enables the same
lookupCtlOwnerIndex entity to have multiple outstanding
requests.
The value of lookupCtlTargetAddressType determines which
lookup function to perform. Specification of dns(16)
as the value of this index implies that the gethostbyname
function should be performed to determine the numeric
addresses associated with a symbolic name via
lookupResultsTable entries. Use of a value of either
ipv4(1) or ipv6(2) implies that the gethostbyaddr function
should be performed to determine the symbolic name(s)
associated with a numeric address at a remote host."INDEX{
lookupCtlOwnerIndex,
lookupCtlOperationName
}
::={ lookupCtlTable 1}
LookupCtlEntry ::=SEQUENCE{
lookupCtlOwnerIndex SnmpAdminString,
lookupCtlOperationName SnmpAdminString,
lookupCtlTargetAddressType InetAddressType,
lookupCtlTargetAddress InetAddress,
lookupCtlOperStatus INTEGER,
lookupCtlTime Unsigned32,
lookupCtlRc Integer32,
lookupCtlRowStatus RowStatus}lookupCtlOwnerIndex OBJECT-TYPESYNTAXSnmpAdminString(SIZE(0..32))MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"To facilitate the provisioning of access control by a
security administrator using the View-Based Access
Control Model (RFC 2575, VACM) for tables in which
multiple users may need to independently create or
modify entries, the initial index is used as an 'owner
index'. Such an initial index has a syntax of
SnmpAdminString, and can thus be trivially mapped to a
securityName or groupName as defined in VACM, in
accordance with a security policy.
When used in conjunction with such a security policy all
entries in the table belonging to a particular user (or
group) will have the same value for this initial index.
For a given user's entries in a particular table, the
object identifiers for the information in these entries
will have the same subidentifiers (except for the
'column' subidentifier) up to the end of the encoded
owner index. To configure VACM to permit access to this
portion of the table, one would create
vacmViewTreeFamilyTable entries with the value of
vacmViewTreeFamilySubtree including the owner index
portion, and vacmViewTreeFamilyMask 'wildcarding' the
column subidentifier. More elaborate configurations
are possible."::={ lookupCtlEntry 1}lookupCtlOperationName OBJECT-TYPESYNTAXSnmpAdminString(SIZE(0..32))MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"The name of a lookup operation. This is locally unique,
within the scope of an lookupCtlOwnerIndex."::={ lookupCtlEntry 2}lookupCtlTargetAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-createSTATUScurrentDESCRIPTION"Specifies the type of address for either performing a
gethostbyname or a gethostbyaddr function at a remote host.
Specification of dns(16) as the value for this object
means that the gethostbyname function should be performed
to return one or more numeric addresses. Use of a value
of either ipv4(1) or ipv6(2) means that the gethostbyaddr
function should be used to return the symbolic names
associated with a remote host."::={ lookupCtlEntry 3}lookupCtlTargetAddress OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-create
STATUScurrentDESCRIPTION"Specifies the address used for a resolver lookup at a
remote host. The corresponding lookupCtlAddressType
objects determines its type as well as the function
that can be requested.
A value for this object MUST be set prior to
transitioning its corresponding lookupCtlEntry to
active(1) via lookupCtlRowStatus."::={ lookupCtlEntry 4}lookupCtlOperStatus OBJECT-TYPESYNTAXINTEGER{notStarted(2),-- operation has not startedcompleted(3)-- operation is done}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Reflects the operational state of an lookupCtlEntry:
enabled(1) - Operation is active.
notStarted(2) - Operation has not been enabled.
completed(3) - Operation has completed.
An operation is automatically enabled(1) when its
lookupCtlRowStatus object is transitioned to active(1)
status. Until this occurs lookupCtlOperStatus MUST
report a value of notStarted(2). After the lookup
operation completes (success or failure) the value
for lookupCtlOperStatus MUST be transitioned to
completed(3)."::={ lookupCtlEntry 5}lookupCtlTime OBJECT-TYPESYNTAXUnsigned32UNITS"milliseconds"MAX-ACCESSread-onlySTATUScurrentDESCRIPTION
"Reports the number of milliseconds that a lookup
operation required to be completed at a remote host.
Completed means operation failure as well as
success."::={ lookupCtlEntry 6}lookupCtlRc OBJECT-TYPESYNTAXInteger32MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The system specific return code from a lookup
operation. All implementations MUST return a value
of 0 for this object when the remote lookup
operation succeeds. A non-zero value for this
objects indicates failure. It is recommended that
implementations that support errno use it as the
value of this object to aid a management
application in determining the cause of failure."::={ lookupCtlEntry 7}lookupCtlRowStatus OBJECT-TYPESYNTAXRowStatusMAX-ACCESSread-createSTATUScurrentDESCRIPTION"This object allows entries to be created and deleted
in the lookupCtlTable.
A remote lookup operation is started when an
entry in this table is created via an SNMP SET
request and the entry is activated. This
occurs by setting the value of this object
to CreateAndGo(4) during row creation or
by setting this object to active(1) after
the row is created.
A value MUST be specified for lookupCtlTargetAddress
prior to a transition to active(1) state being
accepted.
A remote lookup operation starts when its entry
first becomes active(1). Transitions in and
out of active(1) state have no effect on the
operational behavior of a remote lookup
operation, with the exception that deletion of
an entry in this table by setting its RowStatus
object to destroy(6) will stop an active
remote lookup operation.
The operational state of a remote lookup operation
can be determined by examination of its
lookupCtlOperStatus object."REFERENCE"See definition of RowStatus in RFC 2579,
'Textual Conventions for SMIv2.'"::={ lookupCtlEntry 8}-- Lookup Results TablelookupResultsTable OBJECT-TYPESYNTAXSEQUENCEOF LookupResultsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines the Lookup Results Table for providing
the capability of determining the results of a
operation at a remote host.
One or more entries are added to the
lookupResultsTable when a lookup operation,
as reflected by an lookupCtlEntry, completes
successfully. All entries related to a
successful lookup operation MUST be added
to the lookupResultsTable at the same time
that the associating lookupCtlOperStatus
object is transitioned to completed(2).
The number of entries added depends on the
results determined for a particular lookup
operation. All entries associated with an
lookupCtlEntry are removed when the
lookupCtlEntry is deleted.
A remote host can be multi-homed and have more
than one IP address associated with it
(gethostbyname results) and/or it can have more
than one symbolic name (gethostbyaddr results).
The gethostbyaddr function is called with a
host address as its parameter and is used
primarily to determine a symbolic name to
associate with the host address. Entries in
the lookupResultsTable MUST be made for each
host name returned. The official host name MUST
be assigned a lookupResultsIndex of 1.
The gethostbyname function is called with a
symbolic host name and is used primarily to
retrieve a host address. If possible the
primary host address SHOULD be assigned a
lookupResultsIndex of 1."::={ lookupObjects 4}lookupResultsEntry OBJECT-TYPESYNTAX LookupResultsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Defines an entry in the lookupResultsTable. The
first two index elements identify the
lookupCtlEntry that a lookupResultsEntry belongs
to. The third index element selects a single
lookup operation result."INDEX{
lookupCtlOwnerIndex,
lookupCtlOperationName,
lookupResultsIndex
}::={ lookupResultsTable 1}
LookupResultsEntry ::=SEQUENCE{
lookupResultsIndex Unsigned32,
lookupResultsAddressType InetAddressType,
lookupResultsAddress InetAddress}lookupResultsIndex OBJECT-TYPESYNTAXUnsigned32(1..'ffffffff'h)MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Entries in the lookupResultsTable are created when
the result of a lookup operation is determined.
Entries MUST be stored in the lookupResultsTable in
the order that they are retrieved. Values assigned
to lookupResultsIndex MUST start at 1 and increase
in order."::={ lookupResultsEntry 1}
lookupResultsAddressType OBJECT-TYPESYNTAXInetAddressTypeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Indicates the type of result of a remote lookup
operation. A value of unknown(0) implies that
either the operation hasn't been started or that
it has failed."::={ lookupResultsEntry 2}lookupResultsAddress OBJECT-TYPESYNTAXInetAddressMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Reflects a result for a remote lookup operation
as per the value of lookupResultsAddressType."::={ lookupResultsEntry 3}-- Conformance information-- Compliance statementslookupCompliances OBJECTIDENTIFIER::={ lookupConformance 1}lookupGroups OBJECTIDENTIFIER::={ lookupConformance 2}-- Compliance statementslookupCompliance MODULE-COMPLIANCESTATUScurrentDESCRIPTION"The compliance statement for the DISMAN-NSLOOKUP-MIB."MODULE-- this moduleMANDATORY-GROUPS{
lookupGroup
}OBJECT lookupMaxConcurrentRequests
MIN-ACCESSread-only
DESCRIPTION"The agent is not required to support SET
operations to this object."OBJECT lookupPurgeTime
MIN-ACCESSread-onlyDESCRIPTION"The agent is not required to support a SET
operation to this object."::={ lookupCompliances 1}-- MIB groupingslookupGroup OBJECT-GROUPOBJECTS{
lookupMaxConcurrentRequests,
lookupPurgeTime,
lookupCtlOperStatus,
lookupCtlTargetAddressType,
lookupCtlTargetAddress,
lookupCtlTime,
lookupCtlRc,
lookupCtlRowStatus,
lookupResultsAddressType,
lookupResultsAddress
}STATUScurrentDESCRIPTION"The group of objects that comprise the remote
Lookup operation."::={ lookupGroups 1}END